home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1996 November / macformat-043.iso / mac / Shareware Plus / Developers / OpenStack Rinaldi Collection / openstack-rinaldi-lib / XRef 1.3 (US) / XRef 1.3 (US).rsrc / HELP_5635 next >
Encoding:
Text File  |  1996-01-09  |  3.6 KB  |  129 lines
  1.  
  2.  
  3.                                                  XRef 1.3
  4.  
  5.                                           by Frédéric RINALDI
  6.  
  7. DESCRIPTION
  8.   XRef is a tool for cross-referencing handlers, variables and externals in an HC script.
  9.  
  10. SYNTAX
  11.                   XRef(<script>[,<H[andlers]|V[ariables]|X[ternals]>
  12.                           [,<ListAll>[,<ListNb>]]])
  13.  
  14. PARAMETERS
  15.    <script> is the script text to explore
  16.  
  17.    <H[andlers]|V[ariables]|X[ternals]> defines the desired X-Ref mode: by handlers, by variables or by externals.
  18.  
  19.    <ListAll> is a boolean. When TRUE, all subitems are listed for each found entry. Default is FALSE.
  20.  
  21.    <ListNb> is a boolean, used only if <ListAll> = TRUE. When TRUE, all line numbers are listed along with each subitem. Default is FALSE.
  22.  
  23.    Using "!", "?" and "=" as first parameter will return an online help (resp. copyright,  syntax and output).
  24.  
  25. USING
  26.    The XFCN returns a list of found entries, depending of the choosen X-Ref mode. Each entry is followed by its type, which can be [HN] (handler), [LV] (local variable, [GV] (global variable), [XC] (external command) or [XF] (external function).
  27.  
  28. Mode=H, ListAll=FALSE, ListNb=FALSE
  29.    <handler 1>
  30.    …
  31.    <handler N>
  32.  
  33. Mode=H, ListAll=TRUE, ListNb=FALSE
  34.    <handler 1>
  35.    <var/xter 1>[…,<var/xter N>]
  36.  
  37.    …
  38.    <handler N>
  39.    <var/xter 1>[…,<var/xter N>]
  40.  
  41. Mode=H, ListAll=TRUE, ListNb=TRUE
  42.    <handler 1>
  43.    <var/xter 1>: <line 1>[,<line N>]
  44.    …
  45.    <var/xter N>: <line 1>[,<line N>]
  46.  
  47.    …
  48.    <handler N>
  49.    <var/xter 1>: <line 1>[,<line N>]
  50.    …
  51.    <var/xter N>: <line 1>[,<line N>]
  52.  
  53.  
  54. Mode=V, ListAll=FALSE, ListNb=FALSE
  55.    <variable 1>
  56.    …
  57.    <variable N>
  58.  
  59. Mode=V, ListAll=TRUE, ListNb=FALSE
  60.    <variable 1>
  61.    <handler 1>[…,<handler N>]
  62.  
  63.    …
  64.    <variable N>
  65.    <handler 1>[…,<handler N>]
  66.  
  67. Mode=V, ListAll=TRUE, ListNb=TRUE
  68.    <variable 1>
  69.    <handler 1>: <line 1>[,<line N>]
  70.    …
  71.    <handler N>: <line 1>[,<line N>]
  72.  
  73.    …
  74.    <variable N>
  75.    <handler 1>: <line 1>[,<line N>]
  76.    …
  77.    <handler N>: <line 1>[,<line N>]
  78.  
  79.  
  80. Mode=X, ListAll=FALSE, ListNb=FALSE
  81.    <external 1>
  82.    …
  83.    <external N>
  84.  
  85. Mode=X, ListAll=TRUE, ListNb=FALSE
  86.    <external 1>
  87.    <handler 1>[…,<handler N>]
  88.  
  89.    …
  90.    <external N>
  91.    <handler 1>[…,<handler N>]
  92.  
  93. Mode=X, ListAll=TRUE, ListNb=TRUE
  94.    <external 1>
  95.    <handler 1>: <line 1>[,<line N>]
  96.    …
  97.    <handler N>: <line 1>[,<line N>]
  98.  
  99.    …
  100.    <external N>
  101.    <handler 1>: <line 1>[,<line N>]
  102.    …
  103.    <handler N>: <line 1>[,<line N>]
  104.  
  105. ERRORS
  106.    If an error occurs, XRef can return :
  107.      "Error : Out of memory"
  108.      "Error : Missing or empty script parameter"
  109.      "Error : Second param must begin with [H,V,X]"
  110.      "Error : Third param must be boolean"
  111.      "Error : Fourth param must be boolean"
  112.      "Error : Couldn't get WTLK resource"
  113.  
  114. HISTORY
  115. 1.3                                                                                         07/20/92
  116. • Fixed WTLK access for HC 1.2
  117. • Fixed empty string result
  118.                                                                                          
  119. 1.2                                                                                         03/23/92
  120. • First release
  121. --------------------------------------------------------------------
  122.    All externals included in this stack are FreeWare and may be used in non-commercial software provided the following notice is visibly present :
  123.  
  124.                    XRef XFCN, © Frederic Rinaldi, 1989…1993.
  125.  
  126.    Free for non-commercial use. Use in commercial software subjected to prior acknowledgement and licensing from the author, reachable at the following network addresses:
  127.  
  128. AppleLink: RINALDI1   CalvaCom : FR10    Compuserve : 71170,2111
  129.                Internet : RINALDI1@APPLELINK@APPLE.COM